appcompat/androidx.appcompat.widget/[main]AppCompatCheckBox

AppCompatCheckBox

open class AppCompatCheckBox : CheckBox, TintableCompoundButton, TintableBackgroundView, EmojiCompatConfigurationView, TintableCompoundDrawablesView(source)

A CheckBox which supports compatible features on older versions of the platform, including:

Allows dynamic tint of its background via the background tint methods in androidx.core.widget.CompoundButtonCompat.
Allows setting of the background tint using buttonTint and buttonTintMode.

This will automatically be used when you use CheckBox in your layouts and the top-level activity / dialog is provided by appcompat. You should only need to manually use this class when writing custom views.

Constructors

AppCompatCheckBox

constructor(@NonNull context: @NonNull Context)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet)

constructor(@NonNull context: @NonNull Context, @Nullable attrs: @Nullable AttributeSet, defStyleAttr: Int)

Functions

getSupportBackgroundTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Nullable

open fun getSupportBackgroundTintList(): @Nullable ColorStateList

This should be accessed via getBackgroundTintList

getSupportBackgroundTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getSupportBackgroundTintMode(): @Nullable PorterDuff.Mode

This should be accessed via getBackgroundTintMode

getSupportButtonTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Nullable

open fun getSupportButtonTintList(): @Nullable ColorStateList

This should be accessed from androidx.core.widget.CompoundButtonCompat

getSupportButtonTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getSupportButtonTintMode(): @Nullable PorterDuff.Mode

This should be accessed from androidx.core.widget.CompoundButtonCompat

getSupportCompoundDrawablesTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Nullable

open fun getSupportCompoundDrawablesTintList(): @Nullable ColorStateList

This should be accessed via getCompoundDrawableTintList

getSupportCompoundDrawablesTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun getSupportCompoundDrawablesTintMode(): @Nullable PorterDuff.Mode

This should be accessed via getCompoundDrawableTintMode Returns the blending mode used to apply the tint to the compound drawables, if specified.

isEmojiCompatEnabled

open fun isEmojiCompatEnabled(): Boolean

setAllCaps

open fun setAllCaps(allCaps: Boolean)

setBackgroundDrawable

open fun setBackgroundDrawable(@Nullable background: @Nullable Drawable)

setBackgroundResource

open fun setBackgroundResource(@DrawableRes resId: Int)

setButtonDrawable

open fun setButtonDrawable(buttonDrawable: Drawable)

open fun setButtonDrawable(@DrawableRes resId: Int)

setCompoundDrawables

open fun setCompoundDrawables(@Nullable left: @Nullable Drawable, @Nullable top: @Nullable Drawable, @Nullable right: @Nullable Drawable, @Nullable bottom: @Nullable Drawable)

setCompoundDrawablesRelative

open fun setCompoundDrawablesRelative(@Nullable start: @Nullable Drawable, @Nullable top: @Nullable Drawable, @Nullable end: @Nullable Drawable, @Nullable bottom: @Nullable Drawable)

setEmojiCompatEnabled

open fun setEmojiCompatEnabled(enabled: Boolean)

Configure emoji fallback behavior using EmojiCompat.

setFilters

open fun setFilters(filters: @NonNull Array<InputFilter>)

setSupportBackgroundTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportBackgroundTintList(@Nullable tint: @Nullable ColorStateList)

This should be accessed via setBackgroundTintList

setSupportBackgroundTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportBackgroundTintMode(tintMode: @Nullable PorterDuff.Mode)

This should be accessed via setBackgroundTintMode

setSupportButtonTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportButtonTintList(@Nullable tint: @Nullable ColorStateList)

This should be accessed from androidx.core.widget.CompoundButtonCompat

setSupportButtonTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportButtonTintMode(tintMode: @Nullable PorterDuff.Mode)

This should be accessed from androidx.core.widget.CompoundButtonCompat

setSupportCompoundDrawablesTintList

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportCompoundDrawablesTintList(@Nullable tintList: @Nullable ColorStateList)

This should be accessed via setCompoundDrawableTintList Applies a tint to the compound drawables.

setSupportCompoundDrawablesTintMode

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setSupportCompoundDrawablesTintMode(tintMode: @Nullable PorterDuff.Mode)

This should be accessed via setCompoundDrawableTintMode Specifies the blending mode used to apply the tint specified by setSupportCompoundDrawablesTintList to the compound drawables.